/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

package org.erossi.common.model;

import java.io.Serializable;
import java.util.Calendar;

import org.erossi.common.util.AppCtx;

/**
 * 'GenericBean' class: template per i bean.
 * 
 * <p>Incorpora gli attributi standard della base dati, progettata in modo Hibernate-oriented, ovvero:
 *   <ul>
 *     <li><code>id</code> di tipo {@link java.lang.Long}, identificativo univoco del bean per tipo di entità;
 *     <li><code>version</code> di tipo {@link java.lang.Long}, versione della riga, ovvero numero dell'aggiornamento;
 *   </ul>
 * </p>
 * 
 * @author erossi
 * @version Jan 14, 2007
 */
public class GenericBean implements Serializable {
  
  private static final long serialVersionUID = 1L;
  
  private Long id;
  private Long version;
  
  /**
   * Crea una nuova istanza della classe
   */
  public GenericBean() {
    super();
    
    this.id = null;
    this.version = null;
  }
  
  /**
   * Verifica l'uguaglianza fra due oggetti.
   * 
   * <p>
   *   Nel confronto viene verificato il solo attributo {@link #id}.
   * </p>
   * 
   * @param o l'oggetto di cui verificare l'uguaglianza
   */
  public boolean equals (Object o) {

    if (o == null) return false;
    if (!(o instanceof GenericBean)) return false;
    if (this == o) return true;   
    
    boolean equals = false;
    
    GenericBean gb = (GenericBean) o;
    
    if (this.nullSafeEquals(gb.getId(), this.getId())){
      equals = true;
    }
    
    return equals;
    
  }
  
  /**
   * Calcola l'hash per l'oggetto corrente.
   * 
   * <p>
   *   L'hash dell'oggetto é calcolato come hash dell'attributo {@link org.erossi.common.model.GenericBean#id}.
   * </p>
   * 
   * @return l'hash corrispondente all'oggetto corrente
   */
  public int hashCode() {
    
    int hashCode = 0;
    
    if(this.getId() != null) {hashCode += this.getId().hashCode();}
  
    return hashCode;
   
  }
  
  /**
   * Verifica l'uguaglianza fra due oggetti di tipo {@link java.lang.String}.
   * 
   * <p>
   *   Il confronto viene effettuato in maniera null-safe,
   *   ritornando <code>true</code> anche nel caso in cui
   *   entambi i parametri assumano valore <code>null</code>.
   * </p>
   * 
   * @param s1 la prima stringa da confrontare
   * @param s2 la seconda stringa da confrontare
   * @return true se le due stringhe corrispondono, false altrimenti
   */
  protected boolean nullSafeEquals(String s1, String s2) {

    boolean sonoUguali = false;

    if (s1 == null) {
      if (s2 == null) {
        sonoUguali = true;
      } else {
        sonoUguali = false;
      }
    } else {
      if (s2 == null) {
        sonoUguali = false;
      } else {
        if (s1.equals(s2)) {
          sonoUguali = true;
        } else {
          sonoUguali = false;
        }
      }
    }

    return sonoUguali;

  }
  
  /**
   * Verifica l'uguaglianza fra due oggetti di tipo {@link java.lang.Integer},
   * 
   * <p>
   *   Il confronto viene effettuato in maniera null-safe,
   *   ritornando <code>true</code> anche nel caso in cui
   *   entambi i parametri assumano valore <code>null</code>.
   * </p>
   * 
   * @param i1 il primo Integer da confrontare
   * @param i2 il secondo Integer da confrontare
   * @return true se i due Integer corrispondono, false altrimenti
   */
  protected boolean nullSafeEquals(Integer i1, Integer i2) {

    boolean sonoUguali = false;

    if (i1 == null) {
      if (i2 == null) {
        sonoUguali = true;
      } else {
        sonoUguali = false;
      }
    } else {
      if (i2 == null) {
        sonoUguali = false;
      } else {
        if (i1.intValue() == i2.intValue()) {
          sonoUguali = true;
        } else {
          sonoUguali = false;
        }
      }
    }

    return sonoUguali;

  }
  
  /**
   * Verifica l'uguaglianza fra due oggetti di tipo {@link java.lang.Long}.
   * 
   * <p>
   *   Il confronto viene effettuato in maniera null-safe,
   *   ritornando <code>true</code> anche nel caso in cui
   *   entambi i parametri assumano valore <code>null</code>.
   * </p>
   * 
   * <p>
   *   Il confronto viene eseguito tramite l'espressione
   *   <code>l1.longValue() == l2.longValue()</code>
   * </p>
   * 
   * @param l1 il primo long da confrontare
   * @param l2 il secondo long da confrontare
   * @return true se i due long corrispondono, false altrimenti
   */
  protected boolean nullSafeEquals(Long l1, Long l2) {

    boolean sonoUguali = false;

    if (l1 == null) {
      if (l2 == null) {
        sonoUguali = true;
      } else {
        sonoUguali = false;
      }
    } else {
      if (l2 == null) {
        sonoUguali = false;
      } else {
        if (l1.longValue() == l2.longValue()) {
          sonoUguali = true;
        } else {
          sonoUguali = false;
        }
      }
    }

    return sonoUguali;

  }

  /**
   * Verifica l'uguaglianza fra due oggetti di tipo {@link java.lang.Double}.
   * 
   * <p>
   *   Il confronto viene effettuato in maniera null-safe,
   *   ritornando <code>true</code> anche nel caso in cui
   *   entambi i parametri assumano valore <code>null</code>.
   * </p>
   * 
   * <p>
   *   Il confronto viene eseguito tramite l'espressione
   *   <code>d1.doubleValue() == d2.doubleValue()</code>.
   * </p>
   * 
   * @param d1 il primo double da confrontare
   * @param d2 il secondo double da confrontare
   * @return true se i due double corrispondono, false altrimenti
   */
  protected boolean nullSafeEquals(Double d1, Double d2) {

    boolean sonoUguali = false;

    if (d1 == null) {
      if (d2 == null) {
        sonoUguali = true;
      } else {
        sonoUguali = false;
      }
    } else {
      if (d2 == null) {
        sonoUguali = false;
      } else {
        if (d1.doubleValue() == d2.doubleValue()) {
          sonoUguali = true;
        } else {
          sonoUguali = false;
        }
      }
    }

    return sonoUguali;

  }

  /**
   * Verifica l'uguaglianza fra due oggetti di tipo {@link java.util.Calendar}.
   * 
   * <p>
   *   Il confronto viene effettuato in maniera null-safe,
   *   ritornando <code>true</code> anche nel caso in cui
   *   entambi i parametri assumano valore <code>null</code>.
   * </p>
   * <p>
   *   Il confronto viene fatto ignorando i millisecondi, 
   *   poiché alcune basi dati (es. Oracle) non memorizzano tale
   *   precisione nei campi di tipo data. Tale grandezza non é
   *   comunque ritenuta significativa a livello applicativo.
   * </p>
   * 
   * @param c1 il primo Calendar da confrontare
   * @param c2 il secondo Calendar da confrontare
   * @return true se i due Calendar corrispondono, false altrimenti
   */
  protected boolean nullSafeEquals(Calendar c1, Calendar c2) {

    boolean sonoUguali = false;

    if (c1 == null) {
      if (c2 == null) {
        sonoUguali = true;
      } else {
        sonoUguali = false;
      }
    } else {
      if (c2 == null) {
        sonoUguali = false;
      } else {
        
        Calendar c1C = (Calendar) c1.clone();
        Calendar c2C = (Calendar) c2.clone();
        c1C.set(Calendar.MILLISECOND, 0);
        c2C.set(Calendar.MILLISECOND, 0);

        if (c1C.compareTo(c2C) == 0) {
          sonoUguali = true;
        } else {
          sonoUguali = false;
        }
      }
    }

    return sonoUguali;

  }

  /**
   * Verifica l'uguaglianza fra due oggetti di tipo {@link java.lang.Boolean}.
   * 
   * <p>
   *   Il confronto viene effettuato in maniera null-safe,
   *   ritornando <code>true</code> anche nel caso in cui
   *   entambi i parametri assumano valore <code>null</code>.
   * </p>
   * <p>
   *   Il confronto viene eseguito tramite l'espressione
   *   <code>b1.booleanValue() == b2.booleanValue()</code>
   * </p>
   * 
   * @param b1 il primo Boolean da confrontare
   * @param b2 il secondo Boolean da confrontare
   * @return true se i due Boolean corrispondono, false altrimenti
   */
  protected boolean nullSafeEquals(Boolean b1, Boolean b2) {

    boolean sonoUguali = false;

    if (b1 == null) {
      if (b2 == null) {
        sonoUguali = true;
      } else {
        sonoUguali = false;
      }
    } else {
      if (b2 == null) {
        sonoUguali = false;
      } else {
        if (b1.booleanValue() == b2.booleanValue()) {
          sonoUguali = true;
        } else {
          sonoUguali = false;
        }
      }
    }

    return sonoUguali;

  }
  
  /**
   * Restituisce una rappresentazione dell'oggetto
   *   sotto forma di stringa.
   *    
   * @return una stringa {@link java.lang.String}
   *   che rappresenta l'oggetto
   */
  public String toString() {
    
    String toString = new String();
    toString = this.getClass().getName();
    
    toString += AppCtx.printDebug("id", id);
    toString += AppCtx.printDebug("version", version);
    
    return toString;
    
  }

  /**
   * Restituisce il valore dell'attributo 'id'
   * @return il valore dell'attributo id
   */
  public Long getId() {
    return this.id;
  }

  /**
   * Imposta il valore dell'attributo 'id'
   * @param id il valore dell'attributo 'id'
   */
  protected void setId(Long id) {
    this.id = id;
  }

  /**
   * Restituisce il valore dell'attributo 'version'
   * @return il valore dell'attributo version
   */
  public Long getVersion() {
    return this.version;
  }

  /**
   * Imposta il valore dell'attributo 'version'
   * @param version il valore dell'attributo 'version'
   */
  public void setVersion(Long version) {
    this.version = version;
  }

}

